Message Tracker search controls
Use the Custom search panel on the left side of the main Message Tracker page to search for messages by conditions you specify. Messages that match your search conditions are displayed on the search results area of the page (see Search results page). These search tools are available to administrators and users associated with roles that include search permissions.
In addition to the custom searches you create in the Search panel, you can also use the default searches that are listed in the Message tracker menu on the top toolbar. These searches are set up to find all messages traded within past hours or days and also to find failed messages or negative responses to messages within a certain number of days. You can adjust the default searches on the Message Tracker global settings page (see Manage Message Tracker default search settings).
Message Tracker page
Only the top portion of the custom search panel on the left side is displayed.
Custom search
The following describes the controls and fields on the custom search panel on the left side of the main Message Tracker page.
- Search name – If you leave the field blank and click Find, messages matching conditions set in the trading information and date areas on the custom search panel are searched for. Once search results are displayed, you can type a name for the search and click Save. Later you can run the same search again by selecting Message tracker > [name of saved search] under My searches on the menu.
- New – New is a clear action. Use this button to clear the page of search results and begin a search from scratch.
- Save – Save lets you save the conditions for a search you have performed. This button lets you perform the search again without having to set up the conditions again. To save a search, set conditions for a search and click Find to run the search. When the search results are displayed, type a name for the query in the search name field at the top left of the main transaction search page and click Save. To perform a saved search, select Message tracker > [name of saved search] under My searches on the menu.
- Remove – Remove deletes the search identified in the search name field from the My searches menu list.
- Find – Find searches for all records matching the conditions specified on the search page, if any have been specified. If no conditions are specified, the default action is to search for all messages traded within the number of days specified in the Number of days for default searches field on the Message Tracker global settings page (see Manage Message Tracker default search settings).
- Messages per page – The value of this field is the maximum number of search results to display per search results page. If the number of found messages exceeds the page limit, the results are displayed across multiple pages. You can set this maximum on a search-by-search basis.
- Maximum # of search results – The value of this field is the maximum number of messages that return after a search is executed. If a search finds more than this number, the results are trimmed to return only the number up to the maximum. You can set this value on a search-by-search basis, but only to the maximum allowed by a field on the Message Tracker global settings page. Administrators also can change the default value of this field on the global settings page. For more information see Manage Message Tracker default search settings.
Trading information
The following describes the fields under the trading information heading. Use of these fields is optional.
- From – The message sender. You can type a community or partner name or routing ID. Or, click the ellipsis button to select a party. Also, wildcard characters can be used in this field (see Search with wildcard characters).
- To – The message receiver. You can type a community or partner name or routing ID. Or, click the ellipsis button to select a party. Also, wildcard characters can be used in this field (see Search with wildcard characters).
- Note: If you click the ellipsis button to select a partner and have more than 25 partners, a search criteria panel displays to aid in finding the partner you want. The panel enables searching for a partner by name, routing ID and partner category.
- Original filename – The original name of the message file received from a partner or picked up from integration. Using this in conjunction with date or time conditions may result in more useful search results. Wildcard characters can be used in this field (see Search with wildcard characters).
- Delivery filename – The name of the message file sent to a partner or delivered to integration. Using this in conjunction with date or time conditions may result in more useful search results. Wildcard characters can be used in this field (see Search with wildcard characters).
- Document ID – The control ID of an EDI document. Wildcard characters can be used in this field (see Search with wildcard characters).
- Status – The status of the messages to search for: any, delivered, failed, ignored, in process, interrupted, negative response, receiving, resubmitted, resubmitted original, scheduled production, sending, split and waiting for receipt.
- Messages fail for various reasons. Commonly, messages fail because the sender or receiver could not be identified. Activator may have been unable to find a sender or receiver’s routing ID in a parsed message. If a message fails because the sender or receiver could not be determined, check the document for valid routing IDs. You also can search the TE log files in the logs directory for document parsing errors. Look for error or warn events containing the words “parse” or “parsing.”
- If you search for any status, all states but ignored are included. The ignored status is applied to messages Activator has determined lack worthwhile content (for example, an extraneous message received in addition to a message receipt).
- If you search for negative response, Message Tracker returns payloads with negative responses from partners. If you turn off Hide receipts, a search also returns negative response receipts.
- If you search for messages with delivered status, negative responses also are returned. This is because a negative response is a delivered state.
- Activator marks as delivered any outbound message for which an acknowledgment was received, whether positive or negative. An outbound message also is marked as delivered when no acknowledgment is requested. An outbound message in a delivered state has an indicator, viewable in the message details, showing the acknowledgment as positive or negative.
- For a message sent via HTTP, Activator marks a message as delivered when it receives an HTTP 200 OK response. The response is 200 OK for an asynchronous connection and 200 OK plus an acknowledgment for a synchronous connection. If the acknowledgment indicates the receiver had an issue with routing IDs, both parties need to check routing IDs to make sure the IDs match.
- Direction – The direction of the messages to search for:
- any – all messages are included in the search results regardless of origination and destination
- inbound – Partner to Community messages are returned in search results
- outbound – Community to Partner messages are returned in search results
- internal – Inbound (from Partner) messages picked up from the Application Pickup are returned in search results
- external– Messages exchanged Partner to Partner are returned in the search results
- no directions selected – Messages with no routing ID are returned in the search results
- If you search for any direction, all messages are included in the search regardless of origination. A search for inbound finds messages received from partners and routed to integration. A search for outbound finds messages Activator picked up from integration, packaged and sent to partners.
- A search for external does not yield useful results.
- Consumption URL – Allows you to search for messages based on the transport used by a community to pick up messages from integration or receive messages from partners. For example, if a community uses file system integration, copy the pickup location (such as C:\data\ediout) from the transport maintenance page and paste the path in the consumption URL field in Message Tracker.
- Document type – This is EDI document types such as 850, 862. For ebXML, you can use values such as MessageError, Ping, Pong, StatusRequest, StatusResponse, SOAP Fault. For RosettaNet, values include Signal and Action. When you start typing in this field, autocomplete values display, unless an administrator has disabled attribute collecting.
- Document class – Values include Tradacoms, X12, XML, Edifact, Binary. For other classes, you can use the content MIME type without the application/ prefix (for example, use octet-stream instead of application/octet-stream). When you start typing in this field, autocomplete values display, unless an administrator has disabled attribute collecting.
- MIME type – The content MIME type of a document. For example:
-
MIME type
|
Description
|
application/EDI-consent
|
Tradacoms messages
|
application/EDIFACT
|
EDIFACT messages
|
application/EDI-X12
|
X12 messages
|
application/octet-stream
|
Binary messages
|
application/xml
|
XML messages
|
- When you start typing in this field, autocomplete values display, unless an administrator has disabled attribute collecting.
- Attribute – A message attribute or metadata element. For examples of attributes, select Message tracker > Select attributes for pop-up windows. When you start typing in this field, autocomplete values display, unless an administrator has disabled attribute collecting. If you add a searchable attribute, a search field is added under the trading information area. If you add an unsearchable attribute, a field is not added, but a search results column is added as well as a check box for the attribute under the Columns area.
- The following attributes are not searchable:
- Business protocol
- Business protocol version
- Consumption exchange point ID
- Consumption filename extension
- Delivery protocol
- Pickup protocol
- Receipt content
- Rejected reason
- Message ID – A unique identification Activator generates and assigns to a message.
- Core ID – A unique identification Activator generates and assigns to a message. Core IDs are also displayed in log files.
- Conversation ID – Useful when searching for ebXML messages.
- Integration ID – If you have a back-end system or an inline process that supplies a specific value to the available IntegrationId metadata element, you can include the integration ID in a search.
- Hide receipts – Show or hide message receipts in search results.
- Hide protocol messages – Show or hide protocol messages in search results.
- Hide subordinate messages – Show or hide subordinate messages in search results. A subordinate message is one that was split from a parent document. A subordinate message also can be described as a child message of a parent document. In ebXML trading if hide subordinates is turned off, Message Tracker reports two payload messages: the original MMD picked up from integration and the message split from the original MMD. If hide subordinates is turned on, only the original MMD picked up from integration is reported.
Date
To search by date, expand the Date area on the left side below the Trading information area. The selection Don’t search by date means date conditions are not used in searches. To search by date, select Origination or Delivered and select the date or time conditions.
The default settings for searching by date is the Origination or Delivered date Within the last [n] days. If you open the Message Tracker search page and perform a search without changing the date defaults, you may not get the results you expect if many database records are older than the number of days specified in the Within the last [n] days option.
Administrators can change the default value of the option Within the last [n] days on the Message Tracker global settings page (see Manage Message Tracker default search settings).
The After and Before option lets you search for messages traded after or before the date and time you specify. You can set the maximum days after or before the specified date and time on a search-by-search basis. Administrators can change the default maximum days value on the Message Tracker global settings page (see Manage Message Tracker default search settings).
The Specify the dates option lets you specify a search for records whose dates are within a range of dates and times of your choosing.
Columns
Use the Columns section of the left Message Tracker panel to select the columns you want to display when you view search results.
The customized views you create by selecting columns apply only to you and not to other users.
From the list of column names, click the names of columns you want to view. When you select a column name, the column instantly appears in your current results view. If you clear the selection of a column name, the column immediately disappears from the results view.
To rearrange the column order, in the left panel, drag the name of any selected column to a new position in the list. When you do this, the order of columns dynamically changes in the search results panel on the right side of the page.
Hint: Persisting custom column displays
If you modify the default column view of your search results, and then open a detailed view of any search results entry, you will lose your custom column view when you click the back button to return to the search results page (without running a new search query):
Non-persisted method:
- Run a message tracker query to obtain a list of results.
- Modify the column view of the results by adding or removing one or more columns. (The information for any new columns is automatically displayed.)
- Click on any transaction in your list of results to view the detail page for that transaction.
- Click the browser back arrow to return to the results list view.
- Result: The browser displays the default results view, removing your custom changes
Persisted method:
To avoid losing a custom view after you open the detail view:
- Run a message tracker query to obtain a list of results.
- Modify the column view of the results by adding or removing one or more columns. (The information for any new columns is automatically displayed.)
- Click on any transaction in your list of results to view the detail page for that transaction.
- On the menu bar, click the name Message tracker to return to the search results list view. Do not elect any options that appear in the menu
- Result: The browser displays your custom column selections.
Related topics